docs: refresh README and screenshots - #39
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the project’s README to better reflect the dashboard’s static SPA architecture and current UI terminology, and updates minor in-app copy to match the “Admin API JSON” naming used elsewhere in the UI.
Changes:
- Reworked README positioning to emphasize the static, Admin-API-driven dashboard architecture and updated feature descriptions.
- Updated README screenshot layout and references to current 16:9 captures.
- Tweaked Raw API page helper copy to reference “Admin API JSON editors” instead of “resource RAW editors”.
Reviewed changes
Copilot reviewed 2 out of 7 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/routes/raw_api/index.tsx |
Updates helper copy to align with current “Admin API JSON” terminology. |
README.md |
Refreshes architecture/feature narrative and screenshot references to match the current product shape and UI naming. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **Frontend stack** | React 19, Vite 8, TypeScript, Ant Design 6 | | ||
| | **Routing and data** | TanStack Router and TanStack Query | | ||
| | **Forms and validation** | React Hook Form and Zod schemas | | ||
| | **JSON editing** | Monaco-based Payload JSON, Admin API JSON, Plugin JSON, and Request/Response JSON | |
| targets. | ||
| * **Schema-guided JSON Editing**: Use Payload JSON while creating resources, | ||
| Admin API JSON while patching saved resources, Plugin JSON inside plugin | ||
| drawers, and Request/Response JSON in the API Console. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification